RegisterDocument method

Function RegisterDocument(vaultId, jobId, documentId, _ revisionId, publishOptions, renderOptions, _ userName, preventDuplicate, feedbackProperty, customColumns)

Parameters
Name	Description
vaultId	A string that uniquely identifies the vault in which the document resides. Specify Nothing or an empty string to work in the same vault where the VBScript operates. The vault identifier has the syntax \\server\vault, where server is the name of the server computer and vault is the internal name of the vault or datastore. The vault identifier may consist of only a vault name, in which case the vault’s default server, if set, will be assumed.
jobId	A string that uniquely identifies the publishing job name. If the job has multiple destination systems configured and the document should be published to only one of the systems, this string must specify the destination system display name. Use the syntax jobId>systemDisplayName (for example, MyJob>MySystem). If the document should be published to all of the destination systems, the system name should be omitted.
documentId	A string that uniquely identifies the document to publish. Note This parameter accepts either a document ID, path, or Global ID value. However, because the document's Global ID and path can change, we do not recommend using values other than the document ID except under the direction of BlueCielo Technical Support.
revisionId	A string that uniquely identifies the revision of the document. The default is Nothing.
publishOptions	A string that specifies the options for the system links. The default is Nothing. For information about the options that can be specified, see Publishing and rendering options.
renderOptions	A string that specifies the options for the rendering modules. The default is Nothing. For information about the options that can be specified, see Publishing and rendering options.
userName	The name of the user who initiated the task. If Nothing or an empty string, the name of the current user is used.
preventDuplicate	A Boolean value indicating whether to check for duplicate items before adding a new one. If any duplicates are found, the item will not be created. If Nothing, then the option set for the publishing job is used.
feedbackProperty	The name of the property where to store the result of the registration.
customColumns	A 2D array of values (<columnName>, <columnValue>) that represent custom columns in the Publisher Queue database .

Parameters

Name

Description

vaultId

A string that uniquely identifies the vault in which the document resides. Specify Nothing or an empty string to work in the same vault where the VBScript operates. The vault identifier has the syntax \\server\vault, where server is the name of the server computer and vault is the internal name of the vault or datastore. The vault identifier may consist of only a vault name, in which case the vault’s default server, if set, will be assumed.

jobId

A string that uniquely identifies the publishing job name. If the job has multiple destination systems configured and the document should be published to only one of the systems, this string must specify the destination system display name. Use the syntax jobId>systemDisplayName (for example, MyJob>MySystem). If the document should be published to all of the destination systems, the system name should be omitted.

documentId

A string that uniquely identifies the document to publish.

Note This parameter accepts either a document ID, path, or Global ID value. However, because the document's Global ID and path can change, we do not recommend using values other than the document ID except under the direction of BlueCielo Technical Support.

revisionId

A string that uniquely identifies the revision of the document. The default is Nothing.

publishOptions

A string that specifies the options for the system links. The default is Nothing. For information about the options that can be specified, see Publishing and rendering options.

renderOptions

A string that specifies the options for the rendering modules. The default is Nothing. For information about the options that can be specified, see Publishing and rendering options.

userName

The name of the user who initiated the task. If Nothing or an empty string, the name of the current user is used.

preventDuplicate

A Boolean value indicating whether to check for duplicate items before adding a new one. If any duplicates are found, the item will not be created. If Nothing, then the option set for the publishing job is used.

feedbackProperty

The name of the property where to store the result of the registration.

customColumns

A 2D array of values (<columnName>, <columnValue>) that represent custom columns in the Publisher Queue database .

Before calling a RegisterDocument from VBScript, you should create it with the AMCreateObject function and specify the ProgId of the object as described in Registering programmatically without the Task Server. To explicitly delete and release the object, call the Dispose method.

Instantiating a MeridianQueue object to publish documents can take longer than publishing the same document with the PowerUser extension.

Related concepts

Related information

FeedbackProperty property

JobCode property

PreventDuplicate property

PublishOptions property

RenderOptions property

RevisionID property

RevokeBatch method

UserName property


	BlueCielo Meridian Enterprise Server 2013 Administrator's Guide \| BlueCielo ECM Solutions